home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / include / netHppi.h < prev    next >
C/C++ Source or Header  |  1992-09-23  |  4KB  |  101 lines
  1.  
  2. /***********************************************************************
  3.  *
  4.  * netHppi.h
  5.  *
  6.  *    The include file for other modules to use the HPPI network
  7.  *    routines.
  8.  *
  9.  * Copyright 1991 Regents of the University of California
  10.  * Permission to use, copy, modify, and distribute this
  11.  * software and its documentation for any purpose and without
  12.  * fee is hereby granted, provided that the above copyright
  13.  * notice appear in all copies.  The University of California
  14.  * makes no representations about the suitability of this
  15.  * software for any purpose.  It is provided "as is" without
  16.  * express or implied warranty.
  17.  *
  18.  * $Header: /sprite/src/lib/include/RCS/netHppi.h,v 1.2 92/07/06 14:40:39 elm Exp Locker: elm $
  19.  *
  20.  ***********************************************************************
  21.  */
  22.  
  23. #ifndef _NETHPPI
  24. #define    _NETHPPI
  25.  
  26. #include <sprite.h>
  27. #include <list.h>
  28. #include <net.h>
  29. #include <kernel/netTypes.h>
  30. #include <netUltra.h>
  31.  
  32. /*
  33.  * A callback routine for HPPI stuff.
  34.  */
  35. typedef void (*Net_HppiCallback)();
  36.  
  37. /*
  38.  * Single scatter-gather element.
  39.  */
  40. typedef struct Net_HppiSGElem {
  41.     Address    addr;
  42.     int        length;
  43. } Net_HppiSGElem;
  44.  
  45. /*
  46.  * This structure is passed between the HPPI module and higher-level
  47.  * software.  It contains all the connection information that lower
  48.  * and higher level modules should share.
  49.  */
  50. typedef struct Net_HppiConnection {
  51.     Net_Interface*    interPtr;    /* network interface to use */
  52.     unsigned int    connectionId;    /* OUT: connection identifier */
  53.     unsigned int    flags;        /* flags for connection */
  54.     ReturnStatus    status;        /* OUT: connection status */
  55.     ClientData        userData;
  56.     Net_HppiCallback    callbackProc;
  57.     Net_UltraAddress    destAddress;    /* HPPI address to connect to */
  58.     unsigned int    outstandingRecvs;  /* max # of outstanding requests */
  59.     unsigned int    outstandingSends;  /* (for send & receive) */
  60. } Net_HppiConnection;
  61.  
  62. /*
  63.  * This structure describes a single transfer over the HPPI.  There
  64.  * will be many of these per connection, and there may be several
  65.  * outstanding at once.
  66.  */
  67. typedef struct Net_HppiDataRequest {
  68.     List_Links        links;
  69.     Net_Interface*    interPtr;    /* interface request belongs to */
  70.     unsigned int    connectionId;    /* connection data should go on */
  71.     unsigned int    flags;        /* flags for request */
  72.     unsigned int    status;        /* OUT: status of connection */
  73.     ClientData        userData;
  74.     Net_HppiCallback    callbackProc;
  75.     unsigned int    xferSize;    /* total size of transfer */
  76.     unsigned int    xferOffset;    /* offset of first byte within conn */
  77.     unsigned int    sgSize;        /* # of elements in following array */
  78.     Net_HppiSGElem    sg[1];        /* scatter-gather array */
  79. } Net_HppiDataRequest;
  80.  
  81. #define    NET_HPPI_DATA_LAST_SEND    0x1    /* last send in message */
  82.  
  83. extern ReturnStatus    Net_HppiConnectionOpen _ARGS_((Net_HppiConnection*
  84.                                connStatusPtr));
  85. extern ReturnStatus    Net_HppiConnectionListen _ARGS_((Net_HppiConnection*
  86.                             connStatusPtr));
  87. extern ReturnStatus    Net_HppiReceiveData _ARGS_
  88.                 ((Net_HppiConnection* connPtr,
  89.                   Net_HppiDataRequest* dataReqPtr));
  90. extern ReturnStatus    Net_HppiSendData _ARGS_((Net_HppiConnection* connPtr,
  91.                   Net_HppiDataRequest* dataReqPtr));
  92. extern ReturnStatus    Net_HppiConnectionClose _ARGS_((Net_HppiConnection*
  93.                             connPtr));
  94. extern void        Net_HppiLoopback _ARGS_((int hppiNum, int size,
  95.                          void (*callbackProc)(),
  96.                          ClientData clientData));
  97. extern void        Net_HppiSrcPattern _ARGS_((int hppiNum, int size,
  98.                            void (*callbackProc)(),
  99.                            ClientData clientData));
  100. #endif    /* _NETHPPI */
  101.